package com.ihr360.job.core.repeat.exception;

import com.ihr360.job.core.repeat.RepeatContext;

/**
 * Handler to allow strategies for re-throwing exceptions. Normally a
 * {@link CompletionPolicy} will be used to decide whether to end a batch when
 * there is no exception, and the {@link ExceptionHandler} is used to signal an
 * abnormal ending - an abnormal ending would result in an
 * {@link ExceptionHandler} throwing an exception. The caller will catch and
 * re-throw it if necessary.
 *
 * @author Dave Syer
 * @author Robert Kasanicky
 *
 */
public interface ExceptionHandler {

    /**
     * Deal with a Throwable during a batch - decide whether it should be
     * re-thrown in the first place.
     *
     * @param context the current {@link RepeatContext}. Can be used to store
     * state (via attributes), for example to count the number of occurrences of
     * a particular exception type and implement a threshold policy.
     * @param throwable an exception.
     * @throws Throwable implementations are free to re-throw the exception
     */
    void handleException(RepeatContext context, Throwable throwable) throws Throwable;

}